STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: hspc-stdqty

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-stdqty

StandardLabObs is the base Model for standard laboratory test results/observations such as hematology, chemistry, coagulation, serology and blood bank. This model will not be used for microbiology, and anatomic pathology data

This profile was published on Wed, Feb 18, 2015 00:00+1100 as a draft by HSPC.

This profile specifies that the value of the Observation resource must be a valid Observation as defined in the data dictionary HSPC Quantitative Labs dictionary.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from HSPC Standard Lab Observation.

Summary

Mandatory: 2 elements (+4 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 4 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
inv-1: Must have either a value or a dataAbsentReason but not both
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-reporting-priority 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated
... observation-focal-subject ?!0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: HSPC Quantitative Labs (preferred)
... subject ∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Closed, by performer.type
... performer ∑0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer ∑0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... valueQuantity ∑0..1QuantityActual result
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑1..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑1..1stringUnit representation
.... system ∑ I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑1..1codeCoded form of the unit
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... specimen 0..1Reference(hspc-specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... text 1..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from HSPC Standard Lab Observation.

Summary

Mandatory: 2 elements (+4 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 4 elements

Differential View

This structure is derived from HSPC Standard Lab Observation.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
inv-1: Must have either a value or a dataAbsentReason but not both
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-reporting-priority 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority
... hspc-delta-flag 0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag
... hspc-verified 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-verified
... hspc-updated 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-updated
... observation-focal-subject ?!0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: HSPC Quantitative Labs (preferred)
... subject ∑1..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Closed, by performer.type
... performer ∑0..*Reference(hspc-responsibleobserver)the individual with the primary responsibility for the procedure or action being taken
... performer ∑0..1Reference(hspc-performinglaboratory)name and address of the laboratory that performs the test
... valueQuantity ∑0..1QuantityActual result
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑1..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑1..1stringUnit representation
.... system ∑ I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑1..1codeCoded form of the unit
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Abnormal Interpretation Numeric Nom (preferred)
... comment 0..1stringComments about result
... specimen 0..1Reference(hspc-specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... text 1..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeHSPC Quantitative LabspreferredHSPC Quantitative Labs
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationAbnormal Interpretation Numeric NompreferredAbnormal Interpretation Numeric Nom
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

H.??.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
inv-1ObservationMust have either a value or a dataAbsentReason but not both
XPath: (f:value or f:dataAbsentReason) and (not(f:value and f:dataAbsentReason))
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.